-
-
Notifications
You must be signed in to change notification settings - Fork 971
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs(*): fix problems with sample code in documentation #4572
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
zkochan
approved these changes
Apr 14, 2022
This was referenced Apr 30, 2022
This was referenced May 15, 2022
This was referenced May 24, 2022
This was referenced Jun 1, 2022
This was referenced Jun 9, 2022
This was referenced Jun 16, 2022
This was referenced Jun 23, 2022
1 task
ddadaal
pushed a commit
to PKUHPC/SCOW
that referenced
this pull request
Jan 16, 2023
[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [@pnpm/lockfile-file](https://togithub.com/pnpm/pnpm/blob/main/lockfile/lockfile-file#readme) ([source](https://togithub.com/pnpm/pnpm)) | [`6.0.5` -> `7.0.2`](https://renovatebot.com/diffs/npm/@pnpm%2flockfile-file/6.0.5/7.0.2) | [![age](https://badges.renovateapi.com/packages/npm/@pnpm%2flockfile-file/7.0.2/age-slim)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://badges.renovateapi.com/packages/npm/@pnpm%2flockfile-file/7.0.2/adoption-slim)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://badges.renovateapi.com/packages/npm/@pnpm%2flockfile-file/7.0.2/compatibility-slim/6.0.5)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://badges.renovateapi.com/packages/npm/@pnpm%2flockfile-file/7.0.2/confidence-slim/6.0.5)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>pnpm/pnpm</summary> ### [`v7.0.1`](https://togithub.com/pnpm/pnpm/releases/tag/v7.0.1) [Compare Source](https://togithub.com/pnpm/pnpm/compare/v7.0.0...v7.0.1) ##### Patch Changes - Use Yarn's compatibility database to patch broken packages in the ecosystem with package extensions [#​4676](https://togithub.com/pnpm/pnpm/pull/4676). - `pnpm dlx` should work when the bin name of the executed package isn't the same as the package name [#​4672](https://togithub.com/pnpm/pnpm/issues/4672). - Throw an error if arguments are passed to the `pnpm init` command [#​4665](https://togithub.com/pnpm/pnpm/pull/4665). - `pnpm prune` works in a workspace [#​4647](https://togithub.com/pnpm/pnpm/pull/4691). - Do not report request retry warnings when loglevel is set to `error` [#​4669](https://togithub.com/pnpm/pnpm/issues/4669). - `pnpm prune` does not remove hoisted dependencies [#​4647](https://togithub.com/pnpm/pnpm/pull/4691). ##### Our Sponsors <table> <tbody> <tr> <td align="center" valign="middle"> <a href="https://bit.dev/?utm_source=pnpm&utm_medium=release_notes" target="_blank"><img src="https://raw.githubusercontent.com/pnpm/pnpm.github.io/main/static/img/users/bit.svg" width="80"></a> </td> <td align="center" valign="middle"> <a href="https://prisma.io/?utm_source=pnpm&utm_medium=release_notes" target="_blank"><img src="https://raw.githubusercontent.com/pnpm/pnpm.github.io/main/static/img/users/prisma.svg" width="180"></a> </td> <td align="center" valign="middle"> <a href="https://leniolabs.com/?utm_source=pnpm&utm_medium=release_notes" target="_blank"><img src="https://raw.githubusercontent.com/pnpm/pnpm.github.io/main/static/img/users/leniolabs.jpg" width="80"></a> </td> <td align="center" valign="middle"> <a href="https://vercel.com/?utm_source=pnpm&utm_medium=release_notes" target="_blank"><img src="https://raw.githubusercontent.com/pnpm/pnpm.github.io/main/static/img/users/vercel.svg" width="180"></a> </td> <td align="center" valign="middle"> <a href="https://www.takeshape.io/?utm_source=pnpm&utm_medium=release_notes" target="_blank"><img src="https://raw.githubusercontent.com/pnpm/pnpm.github.io/main/static/img/users/takeshape.svg" width="280"></a> </td> </tr> </tbody> </table> ##### New Contributors * @​axe-me made their first contributi[pnpm/pnpm#4654 **Full Changelog**: pnpm/pnpm@v7.0.0...v7.0.1 ### [`v7.0.0`](https://togithub.com/pnpm/pnpm/releases/tag/v7.0.0) #### Major Changes - Node.js 12 is not supported. - When using `pnpm run <script>`, all command line arguments after the script name are now passed to the script's argv, even `--`. For example, the command below will now pass `--hello -- world` to the `echo` script's argv: pnpm run echo --hello -- world Previously, flagged arguments (e.g. `--silent`) were interpreted as pnpm arguments unless `--` came before it. If you want to pass options to pnpm, place them before the script name. For instance: pnpm --workspace-root --silent run echo --hello -- world Read more details about this [in our docs](https://pnpm.io/cli/run#options). Related PR: [#​4290](https://togithub.com/pnpm/pnpm/issues/4290) - The root package is excluded by default, when running `pnpm -r exec|run|add` [#​2769](https://togithub.com/pnpm/pnpm/issues/2769). - Filtering by path is done by globs. In pnpm v6, in order to pick packages under a certain directory, the following filter was used: `--filter=./apps` In pnpm v7, a glob should be used: `--filter=./apps/**` For easier upgrade, we have also added a setting to turn back filtering as it was in v6. Just set `legacy-dir-filtering=true` in `.npmrc`. - The `NODE_PATH` env variable is not set in the command shims (the files in `node_modules/.bin`). This env variable was really long and frequently caused errors on Windows. Also, the `extend-node-path` setting is removed. Related PR: [#​4253](https://togithub.com/pnpm/pnpm/pull/4253) - The `embed-readme` setting is `false` by default. - Side effects cache is turned on by default. To turn it off, use `side-effects-cache=false`. - The `npm_config_argv` env variable is not set for scripts [#​4153](https://togithub.com/pnpm/pnpm/discussions/4153). - `pnpx` is now just an alias of `pnpm dlx`. If you want to just execute the command of a dependency, run `pnpm <cmd>`. For instance, `pnpm eslint`. If you want to install and execute, use `pnpm dlx <pkg name>`. - `pnpm install -g pkg` will add the global command only to a predefined location. pnpm will not try to add a bin to the global Node.js or npm folder. To set the global bin directory, either set the `PNPM_HOME` env variable or the [`global-bin-dir`](https://pnpm.io/npmrc#global-bin-dir) setting. - `pnpm pack` should only pack a file as an executable if it's a bin or listed in the `publishConfig.executableFiles` array. - `-W` is not an alias of `--ignore-workspace-root-check` anymore. Just use `-w` or `--workspace-root` instead, which will also allow to install dependencies in the root of the workspace. - Allow to execute a lifecycle script in a directory that doesn't match the package's name. Previously this was only allowed with the `--unsafe-perm` CLI option [#​3709](https://togithub.com/pnpm/pnpm/issues/3709). - Local dependencies referenced through the `file:` protocol are hard linked (not symlinked) [#​4408](https://togithub.com/pnpm/pnpm/pull/4408). If you need to symlink a dependency, use the `link:` protocol instead. - `strict-peer-dependencies` is `true` by default [#​4427](https://togithub.com/pnpm/pnpm/pull/4427). - A prerelease version is always added as an exact version to `package.json`. If the `next` version of `foo` is `1.0.0-beta.1` then running `pnpm add foo@next` will add this to `package.json`: ```json { "dependencies": { "foo": "1.0.0-beta.1" } } ``` PR: [#​4435](https://togithub.com/pnpm/pnpm/pull/4435) - Dependencies of the root workspace project are not used to resolve peer dependencies of other workspace projects [#​4469](https://togithub.com/pnpm/pnpm/pull/4469). - Don't hoist types by default to the root of `node_modules` [#​4459](https://togithub.com/pnpm/pnpm/pull/4459). - Any package with "prettier" in its name is hoisted. - Changed the location of the global store from `~/.pnpm-store` to `<pnpm home directory>/store` On Linux, by default it will be `~/.local/share/pnpm/store` On Windows: `%LOCALAPPDATA%/pnpm/store` On macOS: `~/Library/pnpm/store` Related issue: [#​2574](https://togithub.com/pnpm/pnpm/issues/2574) There is no migration script for moving the global packages from the old location to the old one. Just reinstall all your global packages with pnpm v7. - [`4bed585`](https://togithub.com/pnpm/pnpm/commit/4bed585e2): The next deprecated settings were removed: - frozen-shrinkwrap - prefer-frozen-shrinkwrap - shared-workspace-shrinkwrap - shrinkwrap-directory - lockfile-directory - shrinkwrap-only - store - Use a base32 hash instead of a hex to encode too long dependency paths inside `node_modules/.pnpm` [#​4552](https://togithub.com/pnpm/pnpm/pull/4552). - New setting added: `git-shallow-hosts`. When cloning repositories from "shallow-hosts", pnpm will use shallow cloning to fetch only the needed commit, not all the history [#​4548](https://togithub.com/pnpm/pnpm/pull/4548). - Lockfile version bumped to v5.4. - Exit with an error when running `pnpm install` in a directory that has no `package.json` file in it (and in parent directories) [#​4609](https://togithub.com/pnpm/pnpm/issues/4609). #### Our Sponsors <table> <tbody> <tr> <td align="center" valign="middle"> <a href="https://bit.dev/?utm_source=pnpm&utm_medium=release_notes" target="_blank"><img src="https://raw.githubusercontent.com/pnpm/pnpm.github.io/main/static/img/users/bit.svg" width="80"></a> </td> <td align="center" valign="middle"> <a href="https://prisma.io/?utm_source=pnpm&utm_medium=release_notes" target="_blank"><img src="https://raw.githubusercontent.com/pnpm/pnpm.github.io/main/static/img/users/prisma.svg" width="180"></a> </td> <td align="center" valign="middle"> <a href="https://leniolabs.com/?utm_source=pnpm&utm_medium=release_notes" target="_blank"><img src="https://raw.githubusercontent.com/pnpm/pnpm.github.io/main/static/img/users/leniolabs.jpg" width="80"></a> </td> <td align="center" valign="middle"> <a href="https://vercel.com/?utm_source=pnpm&utm_medium=release_notes" target="_blank"><img src="https://raw.githubusercontent.com/pnpm/pnpm.github.io/main/static/img/users/vercel.svg" width="180"></a> </td> <td align="center" valign="middle"> <a href="https://www.takeshape.io/?utm_source=pnpm&utm_medium=release_notes" target="_blank"><img src="https://raw.githubusercontent.com/pnpm/pnpm.github.io/main/static/img/users/takeshape.svg" width="280"></a> </td> </tr> </tbody> </table> #### What's Changed * feat!: breaking config changes for v7 by @​zkoch[pnpm/pnpm#4253 * feat(pack)!: limit what files are packed as executables by @​zkoch[pnpm/pnpm#4266 * feat!: pnpx is an alias of pnpm dlx by @​zkoch[pnpm/pnpm#4267 * feat: run scripts without -- by @​glux[pnpm/pnpm#4290 * fix: revert backwards compatible handling of -- for run by @​glux[pnpm/pnpm#4291 * feat!: global bins should be created only in predefined locations by @​zkoch[pnpm/pnpm#4280 * ci: use pnpm v7 by @​zkoch[pnpm/pnpm#4307 * feat!: remove -W option by @​zkoch[pnpm/pnpm#4308 * test(audit): fix for 2022-02-15 by @​glux[pnpm/pnpm#4340 * feat: -F is a short alias of --filter by @​zkoch[pnpm/pnpm#4342 * feat: onlyBuiltDependencies by @​zkoch[pnpm/pnpm#4014 * fix(make-dedicated-lockfile): don't re-resolve dependency versions in dedicated lockfile by @​David-Colli[pnpm/pnpm#4350 * test(audit): mock responses from audit endpoint by @​zkoch[pnpm/pnpm#4354 * fix: bad packageManager field by @​Jack-Wor[pnpm/pnpm#4356 * feat: use the versions from overrides when adding deps without specs by @​zkoch[pnpm/pnpm#4355 * chore: document the interface of command packages by @​illrig[pnpm/pnpm#3828 * fix: print an info message when NODE_ENV is set to production by @​zkoch[pnpm/pnpm#4362 * test: ignore override if a version is specified at install by @​nikolad[pnpm/pnpm#4366 * fix: ignore case, when verifying package name in the store by @​zkoch[pnpm/pnpm#4368 * fix: peerDependencyRules with * as range by @​zkoch[pnpm/pnpm#4370 * feat: run scripts without --unsafe-perm by @​zkoch[pnpm/pnpm#4369 * chore(github): add welcome bot app by @​BlackHol[pnpm/pnpm#4373 * fix: onlyBuiltDependencies should work by @​zkoch[pnpm/pnpm#4377 * fix: pnpm i should work on virtual drives by @​kazua[pnpm/pnpm#4386 * fix: throw a meaningful error message on broken lockfile by @​zkoch[pnpm/pnpm#4387 * fix: don't write data from the lockfile to the global store by @​zkoch[pnpm/pnpm#4395 * fix(resolve-dependencies): a sequence of injected deps via the file protocol by @​zkoch[pnpm/pnpm#4415 * feat: the file protocol should always inject the dependency by @​zkoch[pnpm/pnpm#4408 * feat: add own implementation of the init command by @​zkoch[pnpm/pnpm#4422 * feat: strict-peer-dependencies is true by default by @​zkoch[pnpm/pnpm#4427 * feat: respect the npmrc by @​Spencer1[pnpm/pnpm#4425 * feat: a prerelease version is always saved as an exact version by @​zkoch[pnpm/pnpm#4435 * feat: prevent deep imports using exports by @​zkoch[pnpm/pnpm#4440 * fix: use `@pnpm/graph-sequencer` instead of `graph-sequencer` by @​zkoch[pnpm/pnpm#4458 * fix: fetch should allow the same options as install by @​zkoch[pnpm/pnpm#4460 * fix: typo by @​HomyeeKi[pnpm/pnpm#4462 * fix(lockfile-utils): checking dependenciesMeta by @​zkoch[pnpm/pnpm#4463 * fix: types should not be hoisted to the root of node_modules by @​zkoch[pnpm/pnpm#4459 * chore: replace deprecated String.prototype.substr() by @​CommanderRo[pnpm/pnpm#4479 * Chore/friendly git error by @​law[pnpm/pnpm#4488 * fix: handle undefined version spec by @​tm[pnpm/pnpm#4487 * lint: remove duplicate code by @​mila[pnpm/pnpm#4496 * fix: typo by @​HomyeeKi[pnpm/pnpm#4499 * feat: don't resolve peer dependencies from workspace root by @​zkoch[pnpm/pnpm#4469 * chore: fix typo by @​sudongyu[pnpm/pnpm#4516 * fix: set root by @​HomyeeKi[pnpm/pnpm#4515 * fix(cmd-shim): extend NODE_PATH with path to hidden hoisted dir by @​zkoch[pnpm/pnpm#4513 * chore: public-hoist-pattern prettier config by @​fupen[pnpm/pnpm#3954 * feat: remove deprecated settings by @​zkoch[pnpm/pnpm#4519 * feat: the global store location should be inside the pnpm home directory by @​zkoch[pnpm/pnpm#4522 * fix: the file protocol should link all files by default by @​zkoch[pnpm/pnpm#4532 * fix: dependenciesMeta should be saved into the lockfile by @​zkoch[pnpm/pnpm#4538 * fix: resolve peers from linked in dependencies by @​zkoch[pnpm/pnpm#4541 * fix: peer dependency has workspace protocol by @​zkoch[pnpm/pnpm#4540 * feat: use a shorter hash for dep path by @​zkoch[pnpm/pnpm#4552 * feat(git-fetcher): shallow clone when fetching git resource by @​kenrick[pnpm/pnpm#4548 * style(*): remove duplicate declarations in TypeScript types by @​dev-itshe[pnpm/pnpm#4570 * docs(*): fix problems with sample code in documentation by @​dev-itshe[pnpm/pnpm#4572 * fix(exe): use the strict equality operator, and make `JSON.parse` execute correctly by @​dev-itshe[pnpm/pnpm#4571 * Improve spnpm to use esbuild by @​jond[pnpm/pnpm#4574 * style(*): typo by @​dev-itshe[pnpm/pnpm#4573 * fix(core): prevent duplication of peerDependencyRules in the lockfile by @​kams[pnpm/pnpm#4576 * fix: store integrity check when the lockfile is updated by @​zkoch[pnpm/pnpm#4580 * Fix `add` bug with overlapping workspace packages by @​jond[pnpm/pnpm#4575 * fix(exec): commands of workspace project should be in PATH by @​zkoch[pnpm/pnpm#4583 * fix(default-reporter): use loglevel to filter deprecation warnings (#​4343) by @̴[pnpm/pnpm#4507 * fix: an edge case with peer resolutions and circular deps by @​zkoch[pnpm/pnpm#4588 * feat: shrink path to the global directory (to reduce chance of too long names on Windows) by @​zkoch[pnpm/pnpm#4591 * fix(filter-workspace-packages): filter not working if the path contains Korean characters by @​WhiteKi[pnpm/pnpm#4595 * chore: Set permissions for GitHub actions by @​neilnave[pnpm/pnpm#4607 * fix: only `pnpm install` should fail on peer dep issues by @​zkoch[pnpm/pnpm#4596 * feat: add legacy-dir-filtering by @​zkoch[pnpm/pnpm#4610 * fix(init): don't fail if a parent dir has a package.json by @​zkoch[pnpm/pnpm#4615 * fix: dlx should work without a configured global directory by @​zkoch[pnpm/pnpm#4612 * fix(install): exit with an error when no package.json is found by @​zkoch[pnpm/pnpm#4614 * fix: a file dep has a file dep by @​zkoch[pnpm/pnpm#4618 * fix: publish in workspace by @​zkoch[pnpm/pnpm#4627 * fix: don't fail when moving packages to node_modules/.ignored by @​zkoch[pnpm/pnpm#4626 * fix: global linking by @​zkoch[pnpm/pnpm#4641 * fix(exportable-manifest, types): add typesVersions field to PUBLISH_CONFIG_WHITELIST by @​WhiteKi[pnpm/pnpm#4637 #### New Contributors * @​Jack-Works made their first contributi[pnpm/pnpm#4356 * @​kazuare made their first contributi[pnpm/pnpm#4386 * @​Spencer17x made their first contributi[pnpm/pnpm#4425 * @​HomyeeKing made their first contributi[pnpm/pnpm#4462 * @​CommanderRoot made their first contributi[pnpm/pnpm#4479 * @​lawvs made their first contributi[pnpm/pnpm#4488 * @​tmkx made their first contributi[pnpm/pnpm#4487 * @​sudongyuer made their first contributi[pnpm/pnpm#4516 * @​fupengl made their first contributi[pnpm/pnpm#3954 * @​dev-itsheng made their first contributi[pnpm/pnpm#4570 * @​jondlm made their first contributi[pnpm/pnpm#4574 * @​kamsar made their first contributi[pnpm/pnpm#4576 * @​WhiteKiwi made their first contributi[pnpm/pnpm#4595 * @​neilnaveen made their first contributi[pnpm/pnpm#4607 **Full Changelog**: pnpm/pnpm@v6.31.0...v7.0.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "every weekend" (UTC), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/PKUHPC/SCOW). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNC4xMDAuMSIsInVwZGF0ZWRJblZlciI6IjM0LjEwMC4xIn0=--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As the title and code says.